/*
 * Copyright 2002-2006 the original author or authors. Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy of the License at
 * http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions and limitations under the
 * License.
 */
package pikes.xml;

/**
 * Factory object by which the way of XML printing format can be configured.
 * @author Peter Bona
 * @see XMLVisitor
 */
public interface XMLFormattingConfiguration {

	/**
	 * Static format configuration which creates a non-formatting XMLPrinter, namely {@link XMLWriter}
	 */
	XMLFormattingConfiguration SIMPLE = new XMLFormattingConfiguration() {

		/**
		 * Creates a simple XMWriter object
		 */
		public XMLVisitor createXMLPrinter(Appendable appendable) {
			return new XMLWriter(appendable);
		}

	};

	/**
	 * Creates an {@link XMLVisitor} for the character stream.
	 * @param appendable character stream
	 * @return The XML printer to be used when generating the HTTP response
	 */
	XMLVisitor createXMLPrinter(Appendable appendable);
}
